Language/OS - Multiplatform Resource Library

home *** CD-ROM | disk | FTP | other *** search

/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / cpp_libs / cool / ge_cool.lha / GE_COOL2.1 / man / oldman3 / Bignum.3T < prev next >

Wrap

Text File | 1992-06-26 | 14KB | 464 lines

.TH BIGNUM .SH NAME Bignum Infinite precision integers .SH SYNOPSIS #include <cool/Bignum.h> .SH DESCRIPTION The Bignum class implements near-infinite precision integers and arithmetic by using a dynamic bit vector. A Bignum object will grow in size as necessary to hold its integer value. Implicit conversion to the system defined types short , int , long , float , and double is supported by overloaded operator member functions. Addition and subtraction operators are performed by simple bitwise addition and subtraction on unsigned short boundaries with checks for carry flag propagation. The multiplication, division, and remainder operations utilize the algorithms from Knuth's Volume 2 of \f2"The Art of Computer Programming"\f1. However, despite the use of these algorithms and inline member functions, arithmetic operations on Bignum objects are considerably slower than the built-in integer types that use hardware integer arithmetic capabilities. .PP The Bignum class supports the parsing of character string representations of all the literal number formats. The following table shows an example of a character string representation on the left and a brief description of the interpreted meaning on the right: .sp .nf .ta 2.5i \f2Character String Representation Interpreted Meaning\f1 \l'4.5i' .PP 1234 1234 12341 1234 1234L 1234 1234u 1234 1234U 1234 1234ul 1234 1234UL 1234 01234 1234 in octal (leading 0) 0x1234 1234 in hexadecimal (leading 0x) 0X1234 1234 in hexadecimal (leading 0X) 123.4 123 (value truncated) 1.234e2 123 (exponent expanded/truncated) 1.234e-5 0 (truncated value less than 1) \l'4.5i' .fi .PP The \f3Bignum\f1 class implements common arithmetic exception handling and provides application support for detecting negative infinity, positive infinity, overflow, and underflow that may result from an operation. If one of these conditions is detected, an exception is raised. The programmer can provide an exception handler at runtime to take care of this problem. If no such handler is available, an error message is printed and program execution terminates. See Section 13 for more information on the cool exception handling mechanism. .SH Base Classes .SH Friend Classes None .SH Constructors .TP inline Bignum (); Simple constructor to create a near-infinite precision integer object initialized to zero. .TP \f3Bignum (const char* \f2str\f3);\f1 Constructor to create a near-infinite precision integer object from the character string representation str . .TP \f3Bignum (double \f2d\f3);\f1 Constructor to create a near-infinite precision integer object from the double value d . .TP \f3Bignum (long \f2l\f3);\f1 Constructor to create a near-infinite precision integer object from the long integer value l . .TP \f3Bignum (const Bignum& \f2bn\f3);\f1 Constructor to create a near-infinite precision integer object from bn . .SH Member Functions .TP operator double (); Overloaded operator to provide implicit conversion between Bignum objects and the built-in double type when appropriate. .TP operator float (); Overloaded operator to provide implicit conversion between Bignum objects and the built-in float type when appropriate. .TP operator int (); Overloaded operator to provide implicit conversion between Bignum objects and the built-in int type when appropriate. .TP operator long (); Overloaded operator to provide implicit conversion between Bignum objects and the built-in long type when appropriate. .TP Bignum operator\- () const; Overloads the unary minus operator for the Bignum class and returns a new object whose value is the negated value of the object. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3Bignum& operator= (const char* \f2str\f3);\f1 Overloads the assignment operator for the Bignum class and assigns the integer representation from the character string str to the infinite precision integer object. A reference to the updated object is returned. .TP \f3Bignum& operator= (const \f3Bignum& \f2bn\f3);\f1 Overloads the assignment operator for the Bignum class and assigns bn to the infinite precision integer object. A reference to the updated object is returned. .TP inline Boolean operator! () const; Overloads the unary negation operator for the Bignum class. A new Bignum object is returned as the result. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP Bignum operator~ () const; Overloads the unary exclusive-or operator for the Bignum class. A new Bignum object is returned as the result. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP Bignum& operator++ (); Overloads the increment operator to provide an increment capability for the Bignum class. A reference to the modified Bignum object is returned as the result. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP Bignum& operator\-\^\- (); Overloads the decrement operator to provide a decrement capability for the Bignum class. A reference to the modified Bignum object is returned as the result. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3void operator+= (const Bignum&\f2 bn\f3);\f1 Overloads the addition with assignment operator for the Bignum class. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3void operator\-= (const Bignum& \f2bn\f3);\f1 Overloads the subtraction with assignment operator for the Bignum class. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3Bignum& operator*= (const Bignum& \f2bn\f3);\f1 Overloads the multiplication with assignment operator for the Bignum class. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3void operator/= (const Bignum& \f2bn\f3);\f1 Overloads the division with assignment operator for the Bignum class. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3void operator%= (const Bignum& \f2bn\f3);\f1 Overloads the modulus with assignment operator for the Bignum class. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3void operator&= (const Bignum& \f2bn\f3);\f1 Overloads the logical AND with assignment operator for the Bignum class. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3void operator^= (const Bignum& \f2bn\f3);\f1 Overloads the exclusive-or with assignment operator for the Bignum class. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3void operator|\^= (const Bignum& \f2bn\f3);\f1 Overloads the logical OR with assignment operator for the Bignum class. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3void operator>>= (const Bignum& \f2bn\f3);\f1 Overloads the right shift with assignment operator for the Bignum class. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3void operator<<= (const Bignum& \f2bn\f3);\f1 Overloads the left shift with assignment operator for the Bignum class. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3Boolean operator== (const Bignum& \f2bn\f3) const;\f1 Overloads the equality operator for the Bignum class. This function returns TRUE if the infinite precision integers have the same value; otherwise, this function returns FALSE . .TP \f3inline Boolean operator!= (const Bignum&\f2 bn\f3) const;\f1 Overloads the inequality operator for the Bignum class. This function returns TRUE if the infinite precision integers have different values; otherwise, this function returns FALSE . .TP \f3Boolean operator< (const Bignum&\f2 bn\f3) const;\f1 Overloads the less than operator for the Bignum class and returns TRUE if the object is less than the specified argument; otherwise, this function returns FALSE . .TP \f3inline Boolean operator<= (const Bignum& \f2bn\f3) const;\f1 Overloads the less than or equal operator for the Bignum class. This function returns TRUE if the object is less than or equal to the value of the specified argument; otherwise, this function returns FALSE . .TP \f3Boolean operator> (const Bignum& \f2bn\f3) const;\f1 Overloads the greater than operator for the Bignum class and returns TRUE if the object is greater than the specified argument; otherwise, this function returns FALSE . .TP \f3inline Boolean operator>= (const Bignum& \f2bn\f3) const;\f1 Overloads the greater than or equal operator for the Bignum class. This function returns TRUE if the object is greater than or equal to the value of the specified argument; otherwise, this function returns FALSE . .TP operator short (); Overloaded operator to provide implicit conversion between Bignum objects and the built-in short type when appropriate. .TP inline N_Status status () const; Returns the numerical exception state of the Bignum object. .SH Friend Functions .TP \f3friend Bignum operator+ (const Bignum& \f2bn1\f3, const\f3 Bignum& \f2bn2\f3);\f1 Overloads the addition operator to provide addition for the Bignum class. A new Bignum object is returned as the result. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3inline friend Bignum operator\- (const Bignum& \f2bn1\f3, const \f3Bignum& \f2bn2\f3);\f1 Overloads the subtraction operator to provide subtraction for the Bignum class. A new Bignum object is returned as the result. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3friend Bignum operator* (const Bignum& \f2bn1\f3, const Bignum& \f2bn2\f3);\f1 Overloads the multiplication operator to provide multiplication for the Bignum class. A new Bignum object is returned as the result. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3friend Bignum operator/ (const Bignum& \f2bn1\f3, const Bignum& \f2bn2\f3);\f1 Overloads the division operator for the Bignum class. A new Bignum object is returned as the result. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3friend Bignum operator% (const Bignum& \f2bn1\f3, const Bignum& \f2bn2\f3);\f1 Overloads the modulus operator for the Bignum class. A new Bignum object is returned as the result. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3friend Bignum operator& (const Bignum& \f2bn1\f3, const Bignum& \f2bn2\f3);\f1 Overloads the logical AND operator for the Bignum class. A new Bignum object is returned as the result. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3friend Bignum operator^ (const Bignum& \f2bn1\f3, const Bignum& \f2bn2\f3);\f1 Overloads the logical exclusive-or operator for the Bignum class. A new Bignum object is returned as the result. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3friend Bignum operator| (const Bignum& \f2bn1\f3, const Bignum& \f2bn2\f3);\f1 Overloads the logical OR operator for the Bignum class. A new Bignum object is returned as the result. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3friend Bignum operator>> (const Bignum& \f2bn1\f3, const Bignum& \f2bn2\f3);\f1 Overloads the right shift operator for the Bignum class. A new Bignum object is returned as the result. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3friend Bignum operator<< (const Bignum& \f2bn1\f3, const Bignum& \f2bn2\f3);\f1 Overloads the left shift operator for the Bignum class. A new Bignum object is returned as the result. If the operation results in an arithmetic error of some type, the appropriate exception is raised. .TP \f3friend ostream& operator<< (ostream& \f2os\f3, const Bignum&\f2 bn\f3);\f1 Overloads the output operator for a reference to a Bignum object to provide a formatted output. .TP \f3inline friend ostream& operator<< (ostream& \f2os\f3, const Bignum* \f2bn\f3);\f1 Overloads the output operator for a pointer to a Bignum object to provide a formatted output. .SH NOTE The Bignum class requires that the built-in type long is larger than the built-in type short and can accommodate the result of multiplying two \f3short\f1 values. The maximum positive value that can be represented by the Bignum class is: \s82^(sizeof(unsigned long) * sizeof(unsigned short)) \-1. .SH COPYRIGHT Copyright (C) 1991 Texas Instruments Incorporated. Permission is granted to any individual or institution to use, copy, modify, and distribute this software, provided that this complete copyright and permission notice is maintained, intact, in all copies and supporting documentation. Texas Instruments Incorporated provides this software "as is" without express or implied warranty.